AmazonpayV2随時利用承諾+初回決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranAmazonpay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID 加盟店様が取引を識別するための値を設定します。
JobCd	jobCd	必須半角英字7桁処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount	amount	必須半角数字7桁利用金額
Tax	tax	半角数字7桁税送料税送料を指定した場合は、利用金額 + 税送料が決済金額となります。
AmazonpayType	amazonpayType	必須半角数字1桁 AmazonPay実装タイプ「3」を設定してください。
PaymentType	paymentType	必須半角数字1桁決済タイプ「1」を設定してください。

URL

/payment/EntryTranAmazonpay.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "xxxxxxxx",
    "orderID": "ORDER0000001",
    "jobCd": "AUTH",
    "amount": "1000",
    "amazonpayType": "3",
    "paymentType": "1"
}

URL

/payment/EntryTranAmazonpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=xxxxxxxx&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000&AmazonpayType=3&PaymentType=1

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranAmazonpay 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
AccessPass	accessPass	必須半角英数32桁固定取引パスワード【取引登録】で発行された値を設定します。
OrderID	orderID	必須半角英数記号27桁オーダーID 【取引登録】で指定した値を設定します。
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
RetURL	retURL	必須半角英数記号256桁決済結果戻しURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。指定されたURLにブラウザのリダイレクト経由で決済結果が送信されます。
PaymentTermSec	paymentTermSec	半角数字5桁支払開始期限秒お客様が【決済実行】から【支払手続き開始】を呼び出すまでの期限です。最大86,400秒（1日）呼び出しパラメータが空の場合、120秒で処理されます。
AmazonCheckoutSessionID	amazonCheckoutSessionID	半角英数256桁 AmazonチェックアウトセッションID Amazonログイン後に取得できるamazonCheckoutSessionIdを設定します。 APBを利用しない場合は必須です。ポイント弊社「テスト環境」では正当性チェックを行っていないため、ダミー値でも決済可能です。 ※ただし、AmazonのSANDBOX環境をご利用の場合、正当性チェックが行われます。
FrequencyUnit	frequencyUnit	半角英字5桁決済頻度単位利用承諾ごとに決済頻度が変わる場合に設定してください。以下の値が設定可能です。 Year：年 Month：月 Week：週 Day：日
FrequencyValue	frequencyValue	半角数字4桁決済頻度値利用承諾ごとに決済頻度が変わる場合に設定してください。決済頻度単位に対して以下の範囲で値を設定可能です。 Yearの場合：1～3 Monthの場合：1～36 Weekの場合：1～57 Dayの場合：1～1095 例：三ヶ月ごとに決済を行う場合、FrequencyUnit=Month, FrequencyValue=3となります。
Description	description	全半角255桁注文の説明注文の説明です。 Amazonからお客様へのメールに表示されます。

APBを使用する場合
各パラメータはAPBを使用する場合のみ設定してください。

ApbType	apbType	半角英数10桁 APBタイプ APB利用の場合は、以下いずれかを設定ください。 PayOnly：購入者のAmazon支払い方法のみを使用。デジタル商品など住所情報を使用しない場合に利用します。 PayAndShip：購入者のAmazon支払い方法と配送先を使用。物販など住所情報を使用する場合に利用します。
ShippingCountryCode	shippingCountryCode	全半角2桁配送先国コード APBタイプ:PayAndShipの場合は必須例:JP
ShippingPostalCode	shippingPostalCode	半角数字記号16桁配送先郵便番号 APBタイプ:PayAndShipの場合は必須例:150-0043
ShippingStateOrRegion	shippingStateOrRegion	全半角50桁配送先都道府県 APBタイプ:PayAndShipの場合は必須例:東京都
ShippingAddressLine1	shippingAddressLine1	全半角50桁配送先住所1 APBタイプ:PayAndShipの場合は必須例:渋谷区道玄坂3-14-6
ShippingAddressLine2	shippingAddressLine2	全半角50桁配送先住所2 例:渋谷ビルディング
ShippingAddressLine3	shippingAddressLine3	全半角50桁配送先住所3 例:○○株式会社
ShippingName	shippingName	全半角40桁配送先氏名 APBタイプ:PayAndShipの場合は必須例：テスト花子
ShippingPhoneNumber	shippingPhoneNumber	半角数字記号13桁配送先電話番号 APBタイプ:PayAndShipの場合は必須例：03-0000-0001

URL

/payment/ExecTranAmazonpay.json

リクエストパラメータ

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "retURL": "https://example.com/receive",
    "amazonCheckoutSessionID": "a7b5724e-ec6d-4b9a-8b64-599404b9b564"
}

リクエストパラメータ:APB利用

{
    "shopID": "tshop11223344",
    "shopPass": "PASSWORD",
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
    "orderID": "ORDER0000001",
    "retURL": "https://example.com/receive",
    "amazonCheckoutSessionID": "a7b5724e-ec6d-4b9a-8b64-599404b9b564",
    "apbType": "PayAndShip",
    "shippingCountryCode": "JP",
    "shippingPostalCode": "150-0043",
    "shippingStateOrRegion": "東京都",
    "shippingAddressLine1": "渋谷区道玄坂 3-14-6",
    "shippingAddressLine2": "渋谷ビルディング",
    "shippingAddressLine3": "○○株式会社",
    "shippingName": "テスト 花子",
    "shippingPhoneNumber": "03-0000-0001"
}

URL

/payment/ExecTranAmazonpay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive&AmazonCheckoutSessionID=a7b5724e-ec6d-4b9a-8b64-599404b9b564

リクエストパラメータ:APB利用

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive&AmazonCheckoutSessionID=a7b5724e-ec6d-4b9a-8b64-599404b9b564&ApbType=PayAndShip&ShippingCountryCode=JP&ShippingPostalCode=150-0043&ShippingStateOrRegion=東京都&ShippingAddressLine1=渋谷区道玄坂 3-14-6&ShippingAddressLine2=渋谷ビルディング&ShippingAddressLine3=○○株式会社&ShippingName=テスト 花子&ShippingPhoneNumber=03-0000-0001

レスポンス

正常

AccessID	accessID	必須半角英数32桁固定取引ID
Token	token	必須半角英数64桁固定トークン取引IDのハッシュ値を返却します。
StartURL	startURL	必須半角英数記号256桁支払開始URL 支払手続き開始のURLを返却します。
StartLimitDate	startLimitDate	必須半角数字14桁固定支払開始期限日時支払手続き開始の呼び出し期限を返却します。 yyyyMMddHHmmss書式

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
    "accessID": "a6a6b0061347e90cdef806b39bd28705",
    "token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL",
    "startURL": "https://x01.mul-pay.jp/payment/AmazonpayStart.idPass",
    "startLimitDate": "20190225162711"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.mul-pay.jp/payment/AmazonpayStart.idPass&StartLimitDate=20190225162711

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AmazonpayStart 支払手続き開始

お客様をAmazonPay画面へ遷移させる必要があります。
当サービスのリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。
※取引が特定できない場合、すでに支払いを済ませている場合等は、エラー画面を表示します。

リクエスト

AccessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
Token		必須半角英数64桁固定トークン【決済実行】で発行された値を設定します。

URL

/payment/AmazonpayStart.idPass

リダイレクトページサンプル


<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="AmazonpayRedirectCall" action="{接続先URL}" method="POST">
      <noscript>
        <br>
        <br>
        <center>
          <h2>AmazonPayの決済画面へ遷移します。 </h2>
          <input type="submit" value="続行">
        </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
<!--
 function OnLoadEvent() {
 document.AmazonpayRedirectCall.submit();
 }
//-->
</script>
  </body>
</html>

リダイレクト後、お客様はAmazon画面へ遷移し、決済処理完了後に【決済実行】で指定された決済結果戻しURLへ自動で遷移します。

決済結果受信

Amazonでの決済処理が完了した際に、決済実行時に指定された決済結果戻しURLに結果を通知します。
この決済結果はブラウザ経由で連携されるため、ユーザの操作方法によっては決済完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面、結果通知、決済状態照会にてご確認ください。また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス

正常

ShopID		必須半角英数13桁ショップID
OrderID		必須半角英数記号27桁オーダーID 対象取引のオーダーIDを返却します。
Status		必須現状態 AUTH：仮売上 REQCAPTURE：即時売上受付 CAPTURE：即時売上 PAYFAIL：決済失敗
TranDate		必須半角数字14桁固定処理日時 yyyyMMddHHmmss書式
AmazonChargePermissionID		必須半角英数19桁 AmazonチャージパーミッションID Amazonで取引を特定するためのIDを返却します。
CheckString		必須半角英数64桁改ざんチェック文字列 OrderID、AccessID、ShopID、ShopPass、AmazonChargePermissionIDを連結しSHA256ハッシュした値を返却します。

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

Amazon Pay V2